Skip to main content

AddComment

Adds a comment to the specifed document element or array of Runs.

Syntax

expression.AddComment(element, text, author, userId);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
elementRequiredApiRun[]DocumentElement
textRequiredstringThe comment text (required).
authorRequiredstringThe author's name (optional).
userIdRequiredstringThe user ID of the comment author (optional).

Returns

ApiComment

Example

This example adds text and comment to the first paragraph.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("ONLYOFFICE Document Builder");
Api.AddComment(paragraph, "ONLYOFFICE for developers", "Jane");